home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / util1 / tolmgr21.lha / ToolManager / Docs / toolmanager.doc
Text File  |  1993-05-02  |  9KB  |  276 lines
  1. TABLE OF CONTENTS
  2.  
  3. toolmanager.library/AllocTMHandle
  4. toolmanager.library/ChangeTMObjectTagList
  5. toolmanager.library/CreateTMObjectTagList
  6. toolmanager.library/DeleteTMObject
  7. toolmanager.library/FreeTMHandle
  8. toolmanager.library/QuitToolManager
  9.  
  10. toolmanager.library/AllocTMHandle            toolmanager.library/AllocTMHandle
  11.  
  12.    NAME
  13.         AllocTMHandle -- Allocate a ToolManager handle
  14.  
  15.    SYNOPSIS
  16.         handle = AllocTMHandle()
  17.         D0
  18.  
  19.         void *AllocTMHandle(void)
  20.  
  21.    FUNCTION
  22.         Allocates a ToolManager handle, a private data structure. All
  23.         ToolManager objects will be attached to a handle. The library
  24.         function use the handle to access the objects.
  25.  
  26.    RESULTS
  27.         handle - pointer to the new allocated handle or NULL.
  28.  
  29.    SEE ALSO
  30.         FreeTMHandle()
  31.  
  32. toolmanager.library/ChangeTMObjectTagList toolmanager.library/ChangeTMObjectTagList
  33. toolmanager.library/ChangeTMObjectTags   toolmanager.library/ChangeTMObjectTags
  34.  
  35.    NAME
  36.         ChangeTMObjectTagList -- Change the properties of a ToolManager object
  37.  
  38.    SYNOPSIS
  39.         success = ChangeTMObjectTagList(handle, object, tags)
  40.         D0                              A0      A1      A2
  41.  
  42.         BOOL ChangeTMObjectTagList(void *, char *, struct TagItem *)
  43.  
  44.         success = ChangeTMObjectTags(handle, object, tag1, ...)
  45.  
  46.         BOOL ChangeTMObjectTags(void *, char *, ULONG, ...)
  47.  
  48.    FUNCTION
  49.         Changes the properties of a ToolManager object according to the
  50.         supplied tags. All derived objects will be automagically updated to
  51.         reflect the new properties.
  52.  
  53.    INPUTS
  54.         handle - pointer to a ToolManager handle.
  55.         object - pointer to name of the ToolManager object to change. The
  56.                  object must be attached to the handle.
  57.         tags - list of TagItems, which describe the properties to be changed.
  58.                See CreateTMObjectTagList() for a list of all available tags.
  59.  
  60.    RESULTS
  61.         success - TRUE if properties were changed, otherwise FALSE.
  62.  
  63.    NOTE
  64.         Currently objects of the type TMOBJTYPE_IMAGE can't be changed.
  65.  
  66.    SEE ALSO
  67.         CreateTMObjectTagList()
  68.  
  69. toolmanager.library/CreateTMObjectTagList toolmanager.library/CreateTMObjectTagList
  70. toolmanager.library/CreateTMObjTags         toolmanager.library/CreateTMObjTags
  71.  
  72.    NAME
  73.         CreateTMObjectTagList -- Create a ToolManager object
  74.  
  75.    SYNOPSIS
  76.         success = CreateTMObjectTagList(handle, name, type, tags)
  77.         D0                              A0      A1    D0    A2
  78.  
  79.         BOOL CreateTMObjectTagList(void *, char *, ULONG, struct TagItem *)
  80.  
  81.         success = CreateTMObjectTags(handle, name, type, Tag1, ...)
  82.  
  83.         BOOL CreateTMObjectTags(void *, char *, ULONG, ULONG, ...)
  84.  
  85.    FUNCTION
  86.         Creates a new ToolManager object of the given type. The properties
  87.         will be set according to the supplied tags. The new object will be
  88.         attached to the ToolManager handle.
  89.  
  90.         The following tags are currently supported, see Object.doc for
  91.         detailed description.
  92.  
  93.         NOTE: Every data item referenced by a pointer will NOT BE COPIED! It
  94.               must therefore exist for the lifetime of the object!
  95.  
  96.          Object type: TMOBJTYPE_EXEC
  97.  
  98.            - TMOP_Arguments  (BOOL)
  99.            - TMOP_Command    type depending on TMOP_ExecType
  100.            - TMOP_CurrentDir (char *)
  101.            - TMOP_Delay      (LONG)
  102.            - TMOP_ExecType   (ULONG)
  103.  
  104.               One of:
  105.  
  106.                - TMET_CLI     TMOP_Command contains a pointer to string
  107.                - TMET_WB                       "
  108.                - TMET_ARexx                    "
  109.                - TMET_Dock                     "
  110.                - TMET_HotKey                   "
  111.                - TMET_Network                  "
  112.                - TMET_Hook    TMOP_Command contains a pointer to a Hook
  113.                               structure (see utility/hooks.h). When the exec
  114.                               object is activated, ToolManager will call
  115.                               h_Entry with a pointer to the Hook structure in
  116.                               A0 (hook), a pointer to an AppMessage in A1
  117.                               (message, this may be NULL) and the value of
  118.                               h_Data in A2 (object). The function must return a
  119.                               BOOL (TRUE for success, FALSE for failure).
  120.  
  121.                               NOTE: The function will be called synchronously
  122.                               and in the task context of the ToolManager
  123.                               handler. So it MUST return AS SOON AS POSSIBLE
  124.                               and MUST NOT MODIFY ANYTHING in the tasks
  125.                               context!!!!!
  126.  
  127.            - TMOP_HotKey     (char *)
  128.            - TMOP_Output     (char *)
  129.            - TMOP_Path       (char *)
  130.            - TMOP_Priority   (LONG)
  131.            - TMOP_PubScreen  (char *)
  132.            - TMOP_Stack      (ULONG)
  133.            - TMOP_ToFront    (BOOL)
  134.  
  135.          Object type: TMOBJTYPE_IMAGE
  136.  
  137.            - TMOP_File       (char *)
  138.            - TMOP_Data       (struct TMImageData *)
  139.                                        Pointer to a list of images. All images
  140.                                        MUST be if the same size. Will be
  141.                                        ignored if TMOP_File is specified.
  142.                                        Look into <libraries/toolmanager.h> for
  143.                                        detailed description of the data
  144.                                        structure
  145.  
  146.          Object type: TMOBJTYPE_SOUND
  147.  
  148.            - TMOP_Command    (char *)  ARexx command string for external sound
  149.                                        player
  150.            - TMOP_Port       (char *)  Port name of external sound player
  151.  
  152.          Object type: TMOBJTYPE_MENU
  153.  
  154.            - TMOP_Exec       (char *)
  155.            - TMOP_Sound      (char *)
  156.  
  157.          Object type: TMOBJTYPE_ICON
  158.  
  159.            - TMOP_Exec       (char *)
  160.            - TMOP_Image      (char *)
  161.            - TMOP_LeftEdge   (LONG)
  162.            - TMOP_ShowName   (BOOL)
  163.            - TMOP_Sound      (char *)
  164.            - TMOP_TopEdge    (LONG)
  165.  
  166.          Object type: TMOBJTYPE_DOCK
  167.  
  168.            - TMOP_Activated  (BOOL)
  169.            - TMOP_Centered   (BOOL)
  170.            - TMOP_Columns    (ULONG)
  171.            - TMOP_Font       (struct TextAttr *)
  172.            - TMOP_FrontMost  (BOOL)
  173.            - TMOP_HotKey     (char *)
  174.            - TMOP_LeftEdge   (LONG)
  175.            - TMOP_Menu       (BOOL)
  176.            - TMOP_Pattern    (BOOL)
  177.            - TMOP_PopUp      (BOOL)
  178.            - TMOP_PubScreen  (char *)
  179.            - TMOP_Text       (BOOL)
  180.            - TMOP_Title      (char *)
  181.            - TMOP_Tools      (char **) can be specified several times.
  182.            - TMOP_TopEdge    (LONG)
  183.            - TMOP_Vertical   (BOOL)
  184.  
  185.          Object type: TMOBJTYPE_ACCESS
  186.  
  187.            - TMOP_Exec       (char *)  can be specified several times.
  188.  
  189.    INPUTS
  190.         handle - pointer to a ToolManager handle
  191.         name - pointer to a string which contains the name of the new object.
  192.         type - type of the new object. Must be one of the following:
  193.  
  194.                 TMOBJTYPE_EXEC   (see Object.doc for an detailed explanation
  195.                 TMOBJTYPE_IMAGE   of the object types)
  196.                 TMOBJTYPE_SOUND
  197.                 TMOBJTYPE_MENU
  198.                 TMOBJTYPE_ICON
  199.                 TMOBJTYPE_DOCK
  200.                 TMOBJTYPE_ACCESS
  201.  
  202.                NOTE: Since network request can only access the global
  203.                      configuration, objects of the type TMOBJTYPE_ACCESS are
  204.                      non-functional when used with the toolmanager.library.
  205.  
  206.         tags - list of TagItems, which describe the properties of the new
  207.                object.
  208.  
  209.    RESULTS
  210.         success - TRUE if object could be created, otherwise FALSE.
  211.  
  212.    SEE ALSO
  213.         DeleteTMObject()
  214.  
  215. toolmanager.library/DeleteTMObject          toolmanager.library/DeleteTMObject
  216.  
  217.    NAME
  218.         DeleteTMObject -- Delete a ToolManager object
  219.  
  220.    SYNOPSIS
  221.         success = DeleteTMObject(handle, object)
  222.         D0                       A0      A1
  223.  
  224.         BOOL DeleteTMObject(void *, char *)
  225.  
  226.    FUNCTION
  227.         Deletes a ToolManager object created with CreateTMObjectTagList().
  228.         All derived objects will be automagically updated.
  229.  
  230.    INPUTS
  231.         handle - pointer to a ToolManager handle.
  232.         object - pointer to the name of the ToolManager object to delete.
  233.                  This object must be attached to the handle.
  234.  
  235.    RESULTS
  236.         success - TRUE if object was deleted, otherwise FALSE.
  237.  
  238.    SEE ALSO
  239.         CreateTMObjectTagList()
  240.  
  241. toolmanager.library/FreeTMHandle              toolmanager.library/FreeTMHandle
  242.  
  243.    NAME
  244.         FreeTMHandle -- Free a ToolManager handle
  245.  
  246.    SYNOPSIS
  247.         FreeTMHandle(handle)
  248.                      A0
  249.  
  250.         void FreeTMHandle(void *)
  251.  
  252.    FUNCTION
  253.         Frees a ToolManager handle and deletes all attached objects.
  254.  
  255.    INPUT
  256.         handle - pointer to the ToolManager handle.
  257.  
  258.    SEE ALSO
  259.         AllocTMHandle()
  260.  
  261. toolmanager.library/QuitToolManager        toolmanager.library/QuitToolManager
  262.  
  263.    NAME
  264.         QuitToolManager -- Send quit signal to ToolManager process
  265.  
  266.    SYNOPSIS
  267.         QuitToolManager()
  268.  
  269.         void QuitToolManager(void)
  270.  
  271.    FUNCTION
  272.         Sends quit signal to the ToolManager handler process. The process
  273.         will try to exit as soon as possible.
  274.  
  275.  
  276.